Update documentation for Express v5 #967
Conversation
|
This PR is stale because is has been open for 90 days with no activity. |
📝 WalkthroughWalkthroughPull request adds Express compatibility documentation to the README with examples for v4.x and v5.x, and makes a minor spacing correction in CHANGELOG.md. All changes are documentation-only with no functional code modifications. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In @CHANGELOG.md:
- Line 130: Wrap the bare URL in the CHANGELOG entry so it’s not a bare URL;
update the line containing the node-saml changelog link
(https://github.com/node-saml/node-saml/blob/master/CHANGELOG.md#v400-2022-10-28)
to enclose the URL in angle brackets like <https://...> to satisfy
MD034/no-bare-urls linting.
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
CHANGELOG.mdREADME.md
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
CHANGELOG.md
130-130: Bare URL used
(MD034, no-bare-urls)
🔇 Additional comments (1)
README.md (1)
182-220: Clear and accurate Express v4.x / v5.x compatibility documentation.The new subsections effectively document the differences between Express v4.x and v5.x for the authentication callback setup. Both code examples are syntactically correct and properly show the distinction: v4 requires the external
body-parserpackage, while v5 has built-inurlencoded()middleware. The explanatory text is helpful for users upgrading or choosing between versions.
| #### 💣 Major Changes | ||
|
|
||
| - deps: use node-saml v4. See node-saml changelog for breaking changes: https://github.com/node-saml/node-saml/blob/master/CHANGELOG.md#v400-2022-10-28 [#796](https://github.com/node-saml/passport-saml/pull/796) | ||
| - deps: use node-saml v4. See node-saml changelog for breaking changes: https://github.com/node-saml/node-saml/blob/master/CHANGELOG.md#v400-2022-10-28 [#796](https://github.com/node-saml/passport-saml/pull/796) |
There was a problem hiding this comment.
Wrap bare URL in angle brackets to comply with markdown lint (MD034).
The bare URL should be wrapped in angle brackets: <https://github.com/node-saml/node-saml/blob/master/CHANGELOG.md#v400-2022-10-28> to satisfy the no-bare-urls linting rule.
📝 Proposed fix
- deps: use node-saml v4. See node-saml changelog for breaking changes: https://github.com/node-saml/node-saml/blob/master/CHANGELOG.md#v400-2022-10-28 [#796](https://github.com/node-saml/passport-saml/pull/796)
+ deps: use node-saml v4. See node-saml changelog for breaking changes: <https://github.com/node-saml/node-saml/blob/master/CHANGELOG.md#v400-2022-10-28> [#796](https://github.com/node-saml/passport-saml/pull/796)📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - deps: use node-saml v4. See node-saml changelog for breaking changes: https://github.com/node-saml/node-saml/blob/master/CHANGELOG.md#v400-2022-10-28 [#796](https://github.com/node-saml/passport-saml/pull/796) | |
| - deps: use node-saml v4. See node-saml changelog for breaking changes: <https://github.com/node-saml/node-saml/blob/master/CHANGELOG.md#v400-2022-10-28> [#796](https://github.com/node-saml/passport-saml/pull/796) |
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
130-130: Bare URL used
(MD034, no-bare-urls)
🤖 Prompt for AI Agents
In @CHANGELOG.md at line 130, Wrap the bare URL in the CHANGELOG entry so it’s
not a bare URL; update the line containing the node-saml changelog link
(https://github.com/node-saml/node-saml/blob/master/CHANGELOG.md#v400-2022-10-28)
to enclose the URL in angle brackets like <https://...> to satisfy
MD034/no-bare-urls linting.
3 participants
Description
Update example syntax for Express v5 that does not require
body-parserpackage.Checklist:
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.